Save Wallet Configuration

Type: object

Save different workspaces, each with it's own set of keys, addresses, stake delegations, address book, and more.

No Additional Properties

Type: const
Specific value: "saveConfig"


List or Key-Value Map of Wallet Setup Layers

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Type: object

Create Named Key Artifact: Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse. This is the name property of this workspace and other artifacts will reference to this name property to be included in this workspace. Names cannot collide. Pattern can contain this placeholder variables:key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"key_{kind}_{key}"
"Key Number {index}"


Key reference of the Key artifact you are naming. Uses same variables as namePattern.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Type: const
Specific value: "KeyName"


List or Key-Value Map of Named Artifact Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Create Named Address Artifact: Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse. This is the name property of this workspace and other artifacts will reference to this name property to be included in this workspace. Names cannot collide. Pattern can contain this placeholder variables:key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"key_{kind}_{key}"
"Key Number {index}"


Key reference of the Address artifact you are naming. Uses same variables as namePattern.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Type: const
Specific value: "AddressName"


List or Key-Value Map of Named Artifact Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Create Named AddressBook Artifact: Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse. This is the name property of this workspace and other artifacts will reference to this name property to be included in this workspace. Names cannot collide. Pattern can contain this placeholder variables:key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"key_{kind}_{key}"
"Key Number {index}"


Key reference of the AddressBook artifact you are naming. Uses same variables as namePattern.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Type: const
Specific value: "AddressBookName"


List or Key-Value Map of Named Artifact Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Create Named NativeScript Artifact: Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse. This is the name property of this workspace and other artifacts will reference to this name property to be included in this workspace. Names cannot collide. Pattern can contain this placeholder variables:key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"key_{kind}_{key}"
"Key Number {index}"


Key reference of the NativeScript artifact you are naming. Uses same variables as namePattern.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Type: const
Specific value: "NativeScriptName"


List or Key-Value Map of Named Artifact Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create an Named Artifact. Addresses, Keys, AddressBook contacts, and other artifacts, with an associated Named Artifact are shown on user interface and can be referenced by name on scripts. Unnamed artifacts became orphans, present on wallet artifact store but unreachable.

Same definition as Named Artifact Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Create workspace: a named group of addresses, keys and other artifacts. Users can switch between artifacts for instance to use more receiving addresses, multi-delegate stake, participate in DAOs, sign messages with special keys, and more...

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse. This is the name property of this workspace and other artifacts will reference to this name property to be included in this workspace. Names cannot collide. Pattern can contain this placeholder variables:key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"key_{kind}_{key}"
"Key Number {index}"


Title to show to users. Uses same variables as namePattern.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Description to show to users. Uses same variables as namePattern.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses main address key pairs to sign transactions

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses current address key pairs to sign transactions

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses all workspace addresses key pairs to sign transactions

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses main address key pairs to sign data

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses current address key pairs to sign data

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses all workspace addresses key pairs to sign data

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


This flag allows calling to getAllAddresses API function. This helps to preserve workspace addresses and keys relationships anonymous

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Type: const
Specific value: "Workspace"


List or Key-Value Map of Workspace Creation Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Parameters required to create a Workspace, a named group of addresses, keys and other artifacts. Users can switch between artifacts for instance to use more receiving addresses, multi-delegate stake, participate in DAOs, sign messages with special keys, and more...

No Additional Properties


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses main address key pairs to sign transactions

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses current address key pairs to sign transactions

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses all workspace addresses key pairs to sign transactions

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses main address key pairs to sign data

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses current address key pairs to sign data

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Uses all workspace addresses key pairs to sign data

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create a Workspace, a named group of addresses, keys and other artifacts. Users can switch between artifacts for instance to use more receiving addresses, multi-delegate stake, participate in DAOs, sign messages with special keys, and more...

Same definition as Workspace Creation Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: object

Parameters required to create a Workspace, a named group of addresses, keys and other artifacts. Users can switch between artifacts for instance to use more receiving addresses, multi-delegate stake, participate in DAOs, sign messages with special keys, and more...

Same definition as Workspace Creation Parameters
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Key Pair Derivation

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse.This is the name property of this record. Names cannot collide. Pattern can contain this placeholder variables:key, index, kind, accountIndex, addressIndex

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"key_{kind}_{key}"
"Key Number {index}"

Type: const
Specific value: "Key"


Type: enum (of string)

Must be one of:

  • "spend"
  • "stake"
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


List or Key-Value Map of Key Derivation Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Type: object

Parameters required to derive a child key pair from wallet root private key

No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Type: object

Wallet stores locally specific objects for later reuse.This is the name property of this record. Names cannot collide. Pattern can contain this placeholder variables:key, index, kind, accountIndex, addressIndex


Examples:

"key_{kind}_{key}"
"Key Number {index}"


A valid BIP32-Ed25519 (Shelley) or BIP44-Ed25519 (Byron) Cardano derivation path serialized as string mask with hardenning markers (h or '). Pattern can contain this placeholder variables:key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"m/1852h/1815h/0h/0/0"
"m/1852'/1815'/0'/2/0"
"m/1852h/1815h/0h/0/{index}"
"m/1852'/1815'/{key}'/2/0"
Type: object

Parameters required to derive a child key pair from wallet root private key

No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Type: object

Wallet stores locally specific objects for later reuse.This is the name property of this record. Names cannot collide. Pattern can contain this placeholder variables:key, index, kind, accountIndex, addressIndex


Examples:

"key_{kind}_{key}"
"Key Number {index}"


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Build Address

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse.This is the name property of this record. Names cannot collide. Pattern can contain this placeholder variables:spendPubKeyName, stakePubKeyName, spendNativeScriptName, stakeNativeScriptName, spendPlutusScriptName, stakePlutusScriptName, icarusPubKeyName, spendPubKeyHashHex, stakePubKeyHashHex, spendScriptHashHex, stakeScriptHashHex, icarusPubKeyHex, key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"addr_{key}"
"Address of key hash {spendPubKeyHashHex}"

Type: const
Specific value: "Address"


List or Key-Value Map of Address Builder Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Parameters required to build Cardano Addresses

No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Address Book Contact

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse.This is the name property of this record. Names cannot collide. Pattern can contain this placeholder variables:key, index, address

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Examples:

"key_{kind}_{key}"
"Key Number {index}"

Type: const
Specific value: "AddressBook"


List or Key-Value Map of Address Book Creation Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Parameters required to create an Address Book

No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object

Build Native Script

No Additional Properties


List or Key-Value Map of Default Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Wallet stores locally specific objects for later reuse.This is the name property of this record. Names cannot collide. Pattern can contain this placeholder variables:spendPubKeyName, stakePubKeyName, spendNativeScriptName, stakeNativeScriptName, spendPlutusScriptName, stakePlutusScriptName, icarusPubKeyName, spendPubKeyHashHex, stakePubKeyHashHex, spendScriptHashHex, stakeScriptHashHex, icarusPubKeyHex, key, index

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting

Example:

"native_script_{key}"

Type: const
Specific value: "NativeScript"


List or Key-Value Map of Native Script Builder Parameters

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Type: object

Native Script in hexadecimal encoding

No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


List or Key-Value Map of Native Scripts

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: object

Type: object

Native Script in hexadecimal encoding

No Additional Properties


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Native Scripts

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Native Scripts

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Native Scripts

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


List or Key-Value Map of Native Scripts

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties


List or Key-Value Map of Workspace Id. Wallet UI will logically and visually group all items with the same workspace ids.

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting


List or Key-Value Map of Native Scripts

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: array

Must contain a minimum of 1 items

Each item of this array must be:


Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting
Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:

Type: string

GCScript Inline Scripting Language

Inline scripting language function definitions

set

The function set allows you to set arbitrary data on script context for later reuse.

Arguments:

  • path (string) - path of the value to set
  • value (any) - variable to store

Note: Use get to return the value later

get

The function get allows you to get arbitrary data from script context.

Arguments:

  • path (string) - path of the value to retrieve

Note: Use set to set this values in first place

getArray

Returns an array with each provided argument as an item

Arguments:

  • values (any) - items of the array separated by comma

console

Dumps to console a message (or object)

Arguments:

  • type ('log'|'info'|'warn'|'error') - value to pretty print in the logs
  • value (any) - value to pretty print in the logs

jsonToObj

Parses a JSON string and returns an object

Arguments:

  • value (string) - string value to parse, must be a valid JSON string

objToJson

Turns an object into a valid JSON string

Arguments:

  • value (any) - object to serialize as a JSON string

strToHex

Encodes a utf-8 text string into hexadecimal string

Arguments:

  • value (string) - utf-8 text string

hexToStr

Decodes an hexadecimal string into the former utf-8 text string

Arguments:

  • value (string) - hexadecimal encoded string

strToBase64

Encodes a utf-8 text string into base64 string

Arguments:

  • value (string) - utf-8 text string

base64ToStr

Decodes a base64 string into a utf-8 text string

Arguments:

  • value (string) - base64 encoded string

strToMetadataStr

Automatically splits a utf-8 text string into a list of 64 bytes long strings if value length is bigger than 64 bytes
Otherwise, it returns the original string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string) - string to be adapted for metadata usage

metadataStrToStr

If a list of strings ( produced by strToMetadataStr ) is provided, joins it into a single string
If a string is provided, returns the string

Strings in transaction's auxiliary data (metadata) can't be longer than 64 bytes.
Many standards use a list of short strings as a workaround.
You can use strToMetadataStr and metadataStrToStr to work with metadata strings.

Arguments:

  • value (string | [string]) - string or list of strings produced by strToMetadataStr

truncate

Truncates a string from start to prefixLength characters, attaches a separator string, and finally adds the last suffixLength characters of the string
Usefull for truncating long texts, or hashes and addresses when you want to keep the beginning and the end of them and discard the middle.

Example:

addr1qzk45...gkwg (prefixLength=10 ,suffixLength=4, separator="...")

Arguments:

  • value (string) - string to be truncated
  • prefixLength (number) - initial number of characters to be included in resulting string
  • suffixLength (number) - final number of charactes to be included in resulting string
  • separator (string) - string to be included between prefix and suffix parts of the string

replaceAll

Replaces all match ocurrencies inside str by value

Arguments:

  • str (string) - string where to search and replace
  • match (string) - exact string that will be searched for and replaced by value
  • value (string) - value to replaced with

delay

Pauses the execution for interval milliseconds

Arguments:

  • value (any) - object to serialize as a JSON string

getAddressInfo

Get address information as an object with many usefull properties

Arguments:

  • address (string) - a valid cardano address

sha512

Calculates SHA512 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha256

Calculates SHA256 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

sha1

Calculates SHA1 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

md5

Calculates MD5 hash of data string

Arguments:

  • data (string) - arbitrary string to be hashed

uuid

Generates a random RFC4122 UUID v4

Arguments:

addBigNum

Adds extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the sum as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - addends separated by comma (BigNum)

subBigNum

Substracts extraArgs subtrahends numbers from an initial value minuend. Fails on underflow.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the substraction as a BigNum string.

Arguments:

  • value (string | number) - minuend, initial value (BigNum)
  • extraArgs ([string | number]) - subtrahends separated by comma (BigNum)

mulBigNum

Multiplies extraArgs numbers to an initial value.

BigNum are big positive integers provided as strings.
This function also convert numbers on arguments into BigNum string

Returns the multiplication as a BigNum string.

Arguments:

  • value (string | number) - initial value (BigNum)
  • extraArgs ([string | number]) - Multipliers separated by comma (BigNum)

Same definition as GCScript Inline Scripting